<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/quantum_mutex.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dc/d3d/quantum__mutex_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_mutex.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef BLOOMBERG_QUANTUM_MUTEX_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define BLOOMBERG_QUANTUM_MUTEX_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;quantum/quantum_traits.h&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;quantum/quantum_spinlock.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;quantum/interface/quantum_icontext.h&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;quantum/quantum_yielding_thread.h&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">//                                      class Mutex</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html">   36</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#aea33990f2e839eefc1939f5b1c296e5e">Mutex</a>();</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    </div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#aea33990f2e839eefc1939f5b1c296e5e">Mutex</a>(<span class="keyword">const</span> <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; other) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#adb113121919a992c6819b7cdaa5dff85">operator=</a>(<span class="keyword">const</span> <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; other) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    </div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a1872a5c36145280c97610b06a14cc946">lock</a>();</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    </div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a1872a5c36145280c97610b06a14cc946">lock</a>(<a class="code" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync);</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    </div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a0cc992ecc63c035190fd00738a06a79c">tryLock</a>();</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    </div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#af9236a39187a7bfab8a86960c0c2d562">unlock</a>();</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    </div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="comment">//                                      class Mutex::Guard</span></div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html">   73</a></span>&#160;<span class="comment"></span>    <span class="keyword">class </span><a class="code" href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html">Guard</a></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    {</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keyword">public</span>:</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;        <span class="keyword">explicit</span> <a class="code" href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a3f2d7b6fdb72a1aa632974eb18b8ae56">Guard</a>(<a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; mutex,</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;                       <span class="keywordtype">bool</span> <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a0cc992ecc63c035190fd00738a06a79c">tryLock</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    </div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        <a class="code" href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a3f2d7b6fdb72a1aa632974eb18b8ae56">Guard</a>(<a class="code" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync,</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;              <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; mutex,</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;              <span class="keywordtype">bool</span> <a class="code" href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a0cc992ecc63c035190fd00738a06a79c">tryLock</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        </div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        <a class="code" href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a328f4a28d4e3f0a53bbf249ff81b4c3e">~Guard</a>();</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;        </div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a29978f3926f9f583c65b9eca221b6870">ownsLock</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        </div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    <span class="keyword">private</span>:</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        <span class="comment">//Members</span></div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp;          _mutex;</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        <span class="keywordtype">bool</span>            _ownsLock;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    };</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    </div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <span class="comment">//                                      class Mutex::ReverseGuard</span></div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html">  115</a></span>&#160;<span class="comment"></span>    <span class="keyword">class </span><a class="code" href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html">ReverseGuard</a></div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    {</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <span class="keyword">public</span>:</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        <span class="keyword">explicit</span> <a class="code" href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html#ae2c52df6ebf93d38223a2967d0e463b9">ReverseGuard</a>(<a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; mutex);</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    </div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;        <a class="code" href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html#ae2c52df6ebf93d38223a2967d0e463b9">ReverseGuard</a>(<a class="code" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync,</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;                     <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp; mutex);</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        </div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;        <a class="code" href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html#a59abd95a2ce5f2c551fbacbc291b7753">~ReverseGuard</a>();</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;        </div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    <span class="keyword">private</span>:</div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;        <span class="comment">//Members</span></div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;        <a class="code" href="../../d8/da3/namespaceMutex.html">Mutex</a>&amp;              _mutex;</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;        <a class="code" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>      _sync;</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;    };</div><div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    </div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">class</span> YIELDING&gt;</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    <span class="keywordtype">void</span> lockImpl(YIELDING&amp;&amp; yield);</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;    </div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    <span class="comment">//Members</span></div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    <span class="keyword">mutable</span> <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>  _spinlock;</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;};</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;}}</div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="preprocessor">#include &lt;quantum/impl/quantum_mutex_impl.h&gt;</span></div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;</div><div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="preprocessor">#endif //BLOOMBERG_QUANTUM_MUTEX_H</span></div><div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_html_adb113121919a992c6819b7cdaa5dff85"><div class="ttname"><a href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#adb113121919a992c6819b7cdaa5dff85">Bloomberg::quantum::Mutex::operator=</a></div><div class="ttdeci">Mutex &amp; operator=(const Mutex &amp;other)=delete</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1Guard_html_a328f4a28d4e3f0a53bbf249ff81b4c3e"><div class="ttname"><a href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a328f4a28d4e3f0a53bbf249ff81b4c3e">Bloomberg::quantum::Mutex::Guard::~Guard</a></div><div class="ttdeci">~Guard()</div><div class="ttdoc">Destructor. This will unlock the underlying mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:108</div></div>
<div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_html_af9236a39187a7bfab8a86960c0c2d562"><div class="ttname"><a href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#af9236a39187a7bfab8a86960c0c2d562">Bloomberg::quantum::Mutex::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdoc">Unlock this mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:60</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_html_aea33990f2e839eefc1939f5b1c296e5e"><div class="ttname"><a href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#aea33990f2e839eefc1939f5b1c296e5e">Bloomberg::quantum::Mutex::Mutex</a></div><div class="ttdeci">Mutex()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:29</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1ICoroSync_html_a109b2c4b7d70d53d48bb640a9d849b29"><div class="ttname"><a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">Bloomberg::quantum::ICoroSync::Ptr</a></div><div class="ttdeci">std::shared_ptr&lt; ICoroSync &gt; Ptr</div><div class="ttdef"><b>Definition:</b> quantum_icoro_sync.h:36</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard_html_a59abd95a2ce5f2c551fbacbc291b7753"><div class="ttname"><a href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html#a59abd95a2ce5f2c551fbacbc291b7753">Bloomberg::quantum::Mutex::ReverseGuard::~ReverseGuard</a></div><div class="ttdeci">~ReverseGuard()</div><div class="ttdoc">Destroys this object and locks the underlying mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:133</div></div>
<div class="ttc" id="namespaceMutex_html"><div class="ttname"><a href="../../d8/da3/namespaceMutex.html">Mutex</a></div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1Guard_html_a29978f3926f9f583c65b9eca221b6870"><div class="ttname"><a href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a29978f3926f9f583c65b9eca221b6870">Bloomberg::quantum::Mutex::Guard::ownsLock</a></div><div class="ttdeci">bool ownsLock() const</div><div class="ttdoc">Determines if this object owns the underlying mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:102</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1Guard_html_a3f2d7b6fdb72a1aa632974eb18b8ae56"><div class="ttname"><a href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html#a3f2d7b6fdb72a1aa632974eb18b8ae56">Bloomberg::quantum::Mutex::Guard::Guard</a></div><div class="ttdeci">Guard(Mutex &amp;mutex, bool tryLock=false)</div><div class="ttdoc">Construct this object and lock the passed-in mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:69</div></div>
<div class="ttc" id="namespaceSpinLock_html"><div class="ttname"><a href="../../de/df4/namespaceSpinLock.html">SpinLock</a></div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard_html"><div class="ttname"><a href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html">Bloomberg::quantum::Mutex::ReverseGuard</a></div><div class="ttdef"><b>Definition:</b> quantum_mutex.h:115</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard_html_ae2c52df6ebf93d38223a2967d0e463b9"><div class="ttname"><a href="../../d4/d39/classBloomberg_1_1quantum_1_1Mutex_1_1ReverseGuard.html#ae2c52df6ebf93d38223a2967d0e463b9">Bloomberg::quantum::Mutex::ReverseGuard::ReverseGuard</a></div><div class="ttdeci">ReverseGuard(Mutex &amp;mutex)</div><div class="ttdoc">Construct this object and unlock the passed-in mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:117</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_1_1Guard_html"><div class="ttname"><a href="../../d8/dbb/classBloomberg_1_1quantum_1_1Mutex_1_1Guard.html">Bloomberg::quantum::Mutex::Guard</a></div><div class="ttdef"><b>Definition:</b> quantum_mutex.h:73</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_html_a0cc992ecc63c035190fd00738a06a79c"><div class="ttname"><a href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a0cc992ecc63c035190fd00738a06a79c">Bloomberg::quantum::Mutex::tryLock</a></div><div class="ttdeci">bool tryLock()</div><div class="ttdoc">Tries to lock the mutex object.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:54</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Mutex_html_a1872a5c36145280c97610b06a14cc946"><div class="ttname"><a href="../../d7/d71/classBloomberg_1_1quantum_1_1Mutex.html#a1872a5c36145280c97610b06a14cc946">Bloomberg::quantum::Mutex::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">Locks this mutex.</div><div class="ttdef"><b>Definition:</b> quantum_mutex_impl.h:33</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>quantum_mutex.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
